AnimatePalette

AnimatePalette
Header:	Palettes.h		Carbon status:	Supported

Changes the colors of a series of palette entries; it is similar to the AnimateEntry function, but it acts upon a range of entries.

void AnimatePalette (
    WindowRef dstWindow, 
    CTabHandle srcCTab, 
    SInt16 srcIndex, 
    SInt16 dstEntry, 
    SInt16 dstLength
);

Parameter descriptions

dstWindow: A pointer to the window whose palette colors are to be changed.
srcCTab: A handle to the color table containing the new colors.
srcIndex: The source color table entry at which copying starts.
dstEntry: The palette entry at which copying starts.
dstLength: The number of palette entries to be changed.

DISCUSSION

The AnimatePalette function changes the colors of a series of palette entries. Beginning at the index specified by the srcIndex parameter (which has a minimum value of 0), the number of entries specified in dstLength are copied from the source color table to the destination window’s palette, beginning at the entry specified in the dstEntry parameter. If the source color table specified in srcCTab is not sufficiently large to accommodate the request, AnimatePalette modifies as many entries as possible and leaves the remaining entries unchanged.

AVAILABILITY

Supported in Carbon. Available in Carbon 1.0.2 and later when running Mac OS 8.1 or later.